Skip to content

Improve and update README with current API examples #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 5, 2025
Merged

Improve and update README with current API examples #64

merged 1 commit into from
Oct 5, 2025
+188 −4

Conversation

Jaben
Copy link
Member

@Jaben Jaben commented Oct 5, 2025

Summary

Comprehensive update to the README to reflect current v2.8.1+ API patterns and add documentation for features introduced in v2.6 through v2.8.1.

Changes Made

New Examples Added

  • Cookie Support (v2.8.1) - Demonstrates adding cookies to Chromium cookie jar for authenticated requests
  • SinglePage Property (v2.8.1) - Shows how to generate single-page PDFs from multi-page content
  • Document Metadata (v2.6) - Example of adding custom metadata (Author, Title, Subject, Keywords) to PDFs
  • PDF Format Conversion - Converting PDFs to PDF/A formats using LibrePdfFormats

New Sections

  • Required Using Statements - Lists all necessary namespace imports for easier project setup
  • Advanced Features - Comprehensive section covering:
    • PDF/UA support for both HTML and PDF conversions (v2.4+)
    • Flatten PDFs (v2.8+)
    • Skip Network Idle Event for faster conversions (Gotenberg v8+)
    • Custom Page Properties reference with all available options

Improvements

  • Updated Office merge example to include PDF format setting
  • Fixed enum references (PdfFormats → LibrePdfFormats)
  • Added version tags to examples (e.g., "v2.8.1+", "v2.6+") for clarity
  • All examples now use current API patterns

Test plan

  • Reviewed all code examples for accuracy against current implementation
  • Verified enum names and method signatures match source code
  • Confirmed all new features exist in codebase (Cookie, SinglePage, Metadata, etc.)
  • Checked version tags against CHANGES.MD

🤖 Generated with Claude Code

@Jaben @claude
Improve and update README with current API examples
945706b 
- Added Required Using Statements section for easier setup
- Added new feature examples for v2.6+ through v2.8.1+:
  * Cookie support for authenticated requests (v2.8.1)
  * SinglePage property for single-page PDF output (v2.8.1)
  * Document metadata support (v2.6)
  * PDF format conversion examples
- Added Advanced Features section with:
  * PDF/UA support for HTML and PDF conversions (v2.4+)
  * Flatten PDFs (v2.8+)
  * Skip Network Idle Event (Gotenberg v8+)
  * Custom Page Properties reference
- Updated Office merge example to include PDF format setting
- Fixed enum references (PdfFormats → LibrePdfFormats)
- Added version tags to examples for clarity

All examples now reflect current v2.8.1+ API patterns.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@cursor Cursor
Copy link

cursor bot commented Oct 5, 2025

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on November 7.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 5, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/readme-improvement

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Jaben Jaben changed the base branch from master to develop October 5, 2025 17:59
@Jaben Jaben merged commit 64c5fa9 into develop Oct 5, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Jaben